Customer Meta Data – Groups API

The customer Meta Data (CMD) Groups API is a RESTful web service that enables REVEAL customers to integrate 3^rd party back-office systems to keep group hierarchy information up to date.

Important concepts to understand prior to utilizing any of the available integration methods:

· The customer Meta Data (CMD) Groups API is offered as a RESTful web service

· Standard REST verbs are applied: GET, POST, PUT, DELETE

· Throughout this document, we will reference the unique identifier to be invoked for each of the main objects available to be created or deleted. The unique identifiers used within this API method set include:

o Group ID

o Driver Number

o Vehicle Number

o Employee ID

o Place ID

API Summary Details

API Name	Customer Meta Data – Groups API
Endpoint	https://fleetmatics.apiportal.akana.com/cmd/v1/groups
Operation	GET, POST, PUT, DELETE

GET Group Services

The Customer Meta Data API allows for groups to be updated using the Group Service methods. The Group Service enables integrated users to/from assign or remove drivers, vehicle, or users to specific groups.

GET All Groups

The GET All Groups method provides integration users with the ability to retrieve all groups within a fleet. The integrated user will be able to verify the Group Name that corresponds with a Group ID to ensure proper placement of drivers, vehicles, and users within the Fleetmatics REVEAL account.

GET All Groups Request Header

Operation and Path	GET https://fleetmatics.apiportal.akana/cmd/v1/groups HTTP/1.1
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

GET All Groups Sample Response

[

{

"Name": "CPTESTGROUP",

"Id": "CPTG1"

{

"Name": "CPTESTGROUP 2",

"Id": "CPTG2"

{

"Name": "Entire Fleet",

"Id": "Entire Fleet"

{

"Name": "GNU",

"Id": "GNU"

]

GET All Groups Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

Name

{

"Name": "",

The name of the group created within the REVEAL account.

"Id": ""

}

The unique identifier associated with the group created within the REVEAL account. The Group ID is an alphanumeric field that must be unique within the REVEAL account and will be mandatory in order to reference the group through the integration services.

GET Groups by Group ID

The GET Group by Group ID method provides integration users with the ability to retrieve all groups within a fleet by the Group ID. The integrated user will be able to verify the Group Name that corresponds with a Group ID to ensure proper placement of drivers, vehicles, and users within the Fleetmatics REVEAL account.

GET Groups by Group ID Request Header

Operation and Path	GET https://fleetmatics.apiportal.akana/cmd/v1/groups/{groupid} HTTP/1.1
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

GET Groups by Group ID Sample Response

{

"Name": "CPTESTGROUP",

"Id": "CPTG1"

}

GET Groups by Group ID Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

Name

{

"Name": "",

The name of the group created within the REVEAL account.

"Id": ""

}

GET Groups by Driver Number

The GET Groups by Driver Number method provides integration users with the ability to retrieve all groups the driver belongs to. Results will include Group Name and Group ID. Multiple groups can be returned for each Driver Number provided as drivers can belong to multiple groups within REVEAL.

GET Groups by Driver Number Request Header

Operation and Path	GET https://fleetmatics.apiportal.akana/cmd/v1/groups/drivers/{drivernumber} HTTP/1.1
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

GET Groups by Driver Number Sample Response

[

{

"Name": " Entire Test Fleet1”,

"Id": “999998”

{

"Name": " Entire Test Fleet2",

"Id": "999999"

}

]

GET Groups by Driver Number Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

Name

{

"Name": "",

The name of the group created within the REVEAL account.

"Id": ""

}

GET Groups by Vehicle Number

The GET Groups by Vehicle Number method provides integration users with the ability to retrieve all groups the vehicle belongs to. Results will include Group Name and Group ID. Multiple groups can be returned for each Vehicle Number provided as vehicles can belong to multiple groups within REVEAL.

GET Groups by Vehicle Number Request Header

Operation and Path	GET https://fleetmatics.apiportal.akana/cmd/v1/groups/vehicles/{vehiclenumber} HTTP/1.1
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

GET Groups by Vehicle Number Sample Response

[

{

"Name": " Entire Test Fleet1”,

"Id": "999998"

{

"Name": " Entire Test Fleet2",

"Id": "999999"

}

]

GET Groups by Vehicle Number Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

Name

{

"Name": "",

The name of the group created within the REVEAL account.

"Id": ""

}

GET Groups by Employee ID

The GET Groups by Employee ID method provides integration users with the ability to retrieve all groups the user belongs to. Results will include Group Name and Group ID. Multiple groups can be returned for each Employee ID provided as users can belong to multiple groups within REVEAL.

GET Groups by Employee ID Request Header

Operation and Path	GET https://fleetmatics.apiportal.akana/cmd/v1/groups/users/{employeeid} HTTP/1.1
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

GET Groups by Employee ID Sample Response

[

{

"Name": "Entire Test Fleet1",

"Id": "999997"

{

"Name": "Entire Test Fleet2",

"Id": "999998"

{

"Name": "Entire Test Fleet3",

"Id": "999999"

}

]

GET Groups by Employee ID Response Field Breakdown

Field

[Accepted Format (JSON, XML, etc.)] Formatted Sample

Field Notes and Default Values

Name

{

"Name": "",

The name of the group created within the REVEAL account.

"Id": ""

}

GET Drivers by Group ID

The GET Drivers by Group ID method provides integration users with the ability to retrieve all drivers associated with the Group ID. Results will include Driver Number and other relevant driver details. Multiple drivers can be returned for each Group ID provided as groups can contain multiple drivers within REVEAL.

GET Drivers by Group ID Request Header

Operation and Path	GET https://fleetmatics.apiportal.akana/cmd/v1/drivers?={GroupID} HTTP/1.1
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

GET Sample Response

[

{

"Driver": {

"CreatedDateUTC": "2017-02-27T23:40:00",

"DriverNumber": “1”,

"EmailAddress": "[email protected]",

"FirstName": "User",

"LastName": "Test",

"EnableMobileAccess": false,

"PhoneNumber": "1234567890"

"Links": {

"KeyFobs": {"Href": ""},

"Self": {"Href": ""}

}

{

"Driver": {

"CreatedDateUTC": "2017-05-27T23:40:00",

"DriverNumber": “2”,

"EmailAddress": "[email protected]",

"FirstName": "User",

"LastName": "Test",

"EnableMobileAccess": false,

"PhoneNumber": "1234567890"

"Links": {

"KeyFobs": {"Href": " ": http://api.us.fleetmatics.com/CMD/v1/drivers/100096/Keys"},

"Self": {"Href": " "http://api.us.fleetmatics.com/CMD/v1/drivers/100096"}

}

]

GET Drivers by Group ID Response Field Breakdown

Field	JSON Formatted Sample	Field Notes and Default Values
Created Date UTC	{ "Driver": { "CreatedDateUTC": "",	The date and time stamp in UTC that the stop object was created within REVEAL. The default value will be the current date and time stamp when the stop is invoked.
Driver Number	"DriverNumber": “”,	Driver Number is the unique identifier that will be used to reference the driver within the API. The Driver Number is not a mandatory field within the REVEAL account, but is required for the API.
Email Address	"EmailAddress": "",	The email address associated with the specific driver. The field is optional, unless driver related applications are utilized (Field App or LogBook.) A driver’s email address must be unique within the account.
First Name	"FirstName": "",	The first name associated with the specific driver.
Last Name	"LastName": "",	The last name associated with the specific driver.
Enable Mobile Access	"EnableMobileAccess": “”,	Enable Mobile Access is a Boolean true or false field indicating whether the driver will have access to mobile applications. The default value is false.
Phone Number	"PhoneNumber": "" },	The phone number associated with the driver.
Key Fobs	"Links": { "KeyFobs": {"Href": ""}	For accounts using Driver ID, the driver’s key fob(s) can be found using the key fob API link.

GET Users by Group ID

The GET User by Group ID method provides integration users with the ability to retrieve all users associated with the Group ID. Results will include Employee ID and other relevant user details. Multiple users can be returned for each Group ID provided as groups can contain multiple users within REVEAL.

GET Users by Group ID Request Header

Operation and Path	GET https://fleetmatics.apiportal.akana/cmd/v1/users?={GroupID} HTTP/1.1
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

GET Users by Group ID Sample Response

[

{

"user": {

"FirstName": "AUS",

"LastName": "1",

"EmailAddress": "[email protected]",

"EmployeeId": null,

"IsAdministrator": true,

"IsRegionalAdministrator": false,

"Role": null,

"IsDriver": false

"_links": null

{

"user": {

"FirstName": "AUS",

"LastName": "2",

"EmailAddress": "[email protected]",

"EmployeeId": null,

"IsAdministrator": true,

"IsRegionalAdministrator": false,

"Role": null,

"IsDriver": false

"_links": null

}

]

GET Users by Group ID Response Field Breakdown

Field	JSON Formatted Sample	Field Notes and Default Values
First Name	{ "user": { "FirstName": ""	The first name of the user.
Last Name	"LastName": "",	The last name of the user.
Email Address	"EmailAddress": "",	The email address for the user. The email address is also the REVEAL username login and is mandatory when creating the user.
Employee ID	"EmployeeId": “”,	Employee ID is the unique identifier for the user within REVEAL. The Employee ID is not mandatory within the REVEAL account, but is required for the API.
Is Administrator	"IsAdministrator": “”,	Is Administrator is a Boolean field for true or false. True indicates that the user is an Administrator for the referenced REVEAL account. Administrator is the highest level role within a REVEAL account.
Is Regional Administrator	"IsRegionalAdministrator": “”,	Is Regional Administrator is a Boolean field for true or false. This field can only be set to true if the corresponding REVEAL account is enabled Regional Administrator permission. If you do not know if the account you are working with has Regional Administrator privilege contact Fleetmatics Customer Care or leave the default as false.
Role	"Role": “”,	Role can be NULL if the user an Administrator or Regional Administrator, shown in this example. If the user is not an administrator, then the name of the role applied to the user will be returned. Roles are created within the REVEAL account’s admin section.
Is Driver	"IsDriver": “” },	Is Driver is a Boolean field for true or false. Default is false. When creating or editing a user, the user can be specified to also appear as a driver within the REVEAL account. If the API user requests for a User to also be a Driver, a unique Driver Number must also be provided.
Links	"_links": null } ]	The links provided will enable the integration user to gather additional meta data for a User record. Additionally, the “groups” link will provide details on which groups the User record within the REVEAL account.

GET Vehicles by Group ID

The GET Vehicles by Group ID method provides integration users with the ability to retrieve all vehicles associated with the Group ID. Results will include Vehicle Number and other relevant vehicle details. Multiple vehicles can be returned for each Group ID provided as groups can contain multiple vehicles within REVEAL.

GET Vehicles by Group ID Request Header

Operation and Path	GET https://fleetmatics.apiportal.akana/cmd/v1/vehicles?={GroupID} HTTP/1.1
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

GET Vehicles by Group ID Sample Response

[

{

"Name": "Ed's Car - 4641114658",

"VehicleNumber": "4641114658",

"RegistrationNumber": "RegNumber 196213",

"VIN": null,

"Make": null,

"Year": null,

"Model": null,

"TankCapacity": null,

"HighwayMPG": null,

"CityMPG": null,

"VehicleSize": 0,

"HasNavigationDevice": true

{

"Name": "Ed's Car - 4641063665",

"VehicleNumber": "4641063665",

"RegistrationNumber": "RegNumber 196214",

"VIN": null,

"Make": null,

"Year": null,

"Model": null,

"TankCapacity": null,

"HighwayMPG": null,

"CityMPG": null,

"VehicleSize": 0,

"HasNavigationDevice": false

}

]

GET Vehicles by Group ID Response Field Breakdown

Field	JSON Formatted Sample	Field Notes and Default Values
Name	{ "Name": "",	The Vehicle Name as recorded within the REVEAL vehicle profile.
Vehicle Number	"VehicleNumber": "",	The Vehicle Number is the unique identifier within the API. The Vehicle Number is not a mandatory field within the REVEAL account, but is required for the API.
Registration Number	"RegistrationNumber": "",	Registration Number is not a required field within the REVEAL profile. When the Registration value is provided it will be required to be unique within the account.
VIN	"VIN": "",	Vehicle Identification Number, the unique serial code provided by the automotive manufacturer for the vehicle.
Make	"Make": "",	The vehicle manufacturer’s brand.
Year	"Year": "",	The year the vehicle was manufactured.
Model	"Model": "",	The type of vehicle by the manufacturer.
Tank Capacity	"TankCapacity": "",	Tank Capacity should be provided and referenced in liters. Tank Capacity is not required field but a key element when using Fuel Card features.
Highway MPG	"HighwayMPG": "",	This is an estimated value provided by the customer. The value should be provided and referenced in liters. Highway MPG is not required field but a key element when using Fuel Card features.
City MPG	"CityMPG": "",	City MPG is an estimated value provided by the customer. The value should be provided and referenced in liters. City MPG is not a required field but a key element when using Fuel Card features.
Vehicle Size	"VehicleSize": "",	Vehicle Size refers to the vehicle’s classification of Light-Duty, Medium-Duty, or Heavy Duty. When setting this value via the API, the following values should be referenced: · 0 – Light-Duty · 1 – Medium-Duty · 2 – Heavy-Duty The vehicle’s size will automatically default to Light-Duty.
Has Navigation Device	"HasNavigationDevice": ""	Has Navigation Device is a Boolean field for true or false. This indicates whether the vehicle has a navigation device installed.

POST to Group ID

The integrated user will be able to utilize one of the following methods in order to add information to a specific Group ID.

POST Drivers to Group ID

The POST Drivers by Group ID method provides integration users with the ability to add drivers to a specific Group ID. Requests will require the Driver number in the body and the Group ID in the path. Multiple drivers can be added to each Group ID provided as groups can contain multiple drivers within REVEAL.

If the Driver Number or Group ID are not valid within the account an ERROR will be returned.

When a driver is assigned to a group this will not remove a driver from any of the previously assigned groups. Drivers can belong to multiple groups within REVEAL. If the driver is assigned to a parent group, the driver will also be associated with any subgroups of that parent group.

POST Drivers to Group ID Request Body

Within the body of the request, the integrated user will need to supply the Driver Number in order to add the driver to the provided Group ID. The format of the body should be as follows:

{

"DriverNumber": " 6543-10"

}

POST Drivers to Group ID Request Header

Operation and Path	POST https://fleetmatics.apiportal.akana/cmd/v1/groups/{groupid}/drivers
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

POST Drivers to Group ID Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

Driver Number

{

"DriverNumber": " 6543-10"

}

Driver Number is the unique identifier that will be used to reference the driver within the API. The Driver Number is not a mandatory field within the REVEAL account, but is required for the API.

POST Drivers to Group ID Sample Response

POST methods will not return an object review. The response will be limited to a set of standard HTTP codes:

· Successfully edited vehicles will return a 200 code

· Unfound Vehicle Numbers, or the unique identifier used for the call, will return a 404 error

· Bad requests, typically due to an error in the call’s content, will return a 400 error

· Invalid tokens or an Authorization problem will return a 401 error

· If the service is unavailable at the time the call was made a 500 error will return

POST Users to Group ID

The POST Users by Group ID method provides integration users with the ability to add users to a specific Group ID. Requests will require the Employee ID in the body and the Group ID in the path. Multiple users can be added to each Group ID provided as groups can contain multiple users within REVEAL.

If the Employee ID or Group ID are not valid within the account an ERROR will be returned.

When a user is assigned to a group this will not remove a user from any of the previously assigned groups. Users can belong to multiple groups within REVEAL. If the user is assigned to a parent group, the user will also be associated with any subgroups of that parent group.

POST Users to Group ID Request Body

Within the body of the request, the integrated user will need to supply the Employee ID in order to add the user to the provided Group ID. The format of the body should be as follows:

{

"EmployeeId": 324234346

}

POST Users to Group ID Request Header

Operation and Path	POST https://fleetmatics.apiportal.akana/cmd/v1/groups/{groupid}/users
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

POST Users to Group ID Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

Employee ID

{

"EmployeeId": 324234346

}

Employee ID is the unique identifier for the user within REVEAL. The Employee ID is not mandatory within the REVEAL account, but is required for the API.

POST Users to Group ID Sample Response

POST methods will not return an object review. The response will be limited to a set of standard HTTP codes:

· Successfully edited vehicles will return a 200 code

· Unfound Vehicle Numbers, or the unique identifier used for the call, will return a 404 error

· Bad requests, typically due to an error in the call’s content, will return a 400 error

· Invalid tokens or an Authorization problem will return a 401 error

· If the service is unavailable at the time the call was made a 500 error will return

POST Vehicles to Group ID

The POST Vehicles by Group ID method provides integration users with the ability to add vehicles to a specific Group ID. Requests will require the Vehicle Number in the body and the Group ID in the path. Multiple vehicles can be added to each Group ID provided as groups can contain multiple vehicles within REVEAL.

If the Vehicle Number or Group ID are not valid within the account an ERROR will be returned.

When a vehicle is assigned to a group this will not remove a vehicle from any of the previously assigned groups. Vehicles can belong to multiple groups within REVEAL. If the vehicle is assigned to a parent group, the vehicle will also be associated with any subgroups of that parent group.

POST Vehicles to Group ID Request Body

Within the body of the request, the integrated user will need to supply the Vehicle Number in order to add the vehicle to the provided Group ID. The format of the body should be as follows:

{

"VehicleNumber": "77771-1"

}

POST Vehicles to Group ID Request Header

Operation and Path	POST https://fleetmatics.apiportal.akana/cmd/v1/groups/{groupid}/vehicles
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

POST Vehicles to Group ID Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

Vehicle Number

{

"VehicleNumber": "77771-1"

}

The Vehicle Number is the unique identifier within the API. The Vehicle Number is not a mandatory field within the REVEAL account, but is required for the API.

POST Vehicles to Group ID Sample Request

POST methods will not return an object review. The response will be limited to a set of standard HTTP codes:

· Successfully edited vehicles will return a 200 code

· Unfound Vehicle Numbers, or the unique identifier used for the call, will return a 404 error

· Bad requests, typically due to an error in the call’s content, will return a 400 error

· Invalid tokens or an Authorization problem will return a 401 error

· If the service is unavailable at the time the call was made a 500 error will return

POST Geofences to Group ID

The POST Geofences Vehicles by Group ID method provides integration users with the ability to add geofences to a specific Group ID. Requests will require the Place ID in the body and the Group ID in the path. Multiple geofences can be added to each Group ID provided as groups can contain multiple vehicles within REVEAL.

If the Place ID or Group ID are not valid within the account an ERROR will be returned.

Geofences can be assigned to multiple groups. Adding a Geofence to a group will not remove the Geofence from another group.

POST Geofences to Group ID Request Body

Within the body of the request, the integrated user will need to supply the Place ID in order to add the geofence to the provided Group ID. The format of the body should be as follows:

{

"PlaceId": "WCB-Circle-151112-1"

}

POST Geofences to Group ID Request Header

Operation and Path	POST https://fleetmatics.apiportal.akana/cmd/v1/groups/{groupid}/geofences
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

POST Geofences to Group ID Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

Place ID

{

"PlaceId": "WCB-Circle-151112-1"

}

Place ID is a unique value within a REVEAL account that is used to identify a Geofence. To use the Geospatial API the Place ID is a mandatory field. The Place ID can be NULL for a returned Geofence.

POST Geofences to Group ID Sample Response

POST methods will not return an object review. The response will be limited to a set of standard HTTP codes:

· Successfully edited vehicles will return a 200 code

· Unfound Vehicle Numbers, or the unique identifier used for the call, will return a 404 error

· Bad requests, typically due to an error in the call’s content, will return a 400 error

· Invalid tokens or an Authorization problem will return a 401 error

· If the service is unavailable at the time the call was made a 500 error will return

DELETE from Group ID

The integrated user will be able to remove information from a specified group by providing a Group ID.

DELETE Drivers from Group ID

The DELETE Driver by Group ID method provides integration users with the ability to remove drivers from a specific Group ID. Requests will require the Driver Number and the Group ID in the path. Multiple drivers can be removed to from each Group ID provided as groups can contain multiple drivers within REVEAL.

If the Driver Number or Group ID are not valid within the account an ERROR will be returned.

Note: if the driver is removed from all group associations, it will be placed within the Ungrouped Group within the account. Invoking this method does NOT delete the driver record from the REVEAL account.

Operation and Path	DELETE https://fleetmatics.apiportal.akana/cmd/v1/groups/{groupid}/drivers/ {drivernumber}
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

DELETE Drivers from Group ID Sample Response

DELETE methods will not return an object review. The response will be limited to a set of standard HTTP codes:

· Successfully edited vehicles will return a 200 code

· Unfound Vehicle Numbers, or the unique identifier used for the call, will return a 404 error

· Bad requests, typically due to an error in the call’s content, will return a 400 error

· Invalid tokens or an Authorization problem will return a 401 error

· If the service is unavailable at the time the call was made a 500 error will return

DELETE Users from Group ID

The DELETE User by Group ID method provides integration users with the ability to remove users from a specific Group ID. Requests will require the Employee ID and the Group ID in the path. Multiple users can be removed to from each Group ID provided as groups can contain multiple users within REVEAL.

If the Employee ID or Group ID are not valid within the account an ERROR will be returned.

Note: if the user is removed from all group associations, it will be placed within the Ungrouped Group within the account. Invoking this method does NOT delete the user record from the REVEAL account.

Operation and Path	DELETE https://fleetmatics.apiportal.akana/cmd/v1/groups/{groupid}/users/ {employeeid}
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

DELETE Users from Group ID Sample Response

DELETE methods will not return an object review. The response will be limited to a set of standard HTTP codes:

· Successfully edited vehicles will return a 200 code

· Unfound Vehicle Numbers, or the unique identifier used for the call, will return a 404 error

· Bad requests, typically due to an error in the call’s content, will return a 400 error

· Invalid tokens or an Authorization problem will return a 401 error

· If the service is unavailable at the time the call was made a 500 error will return

DELETE Vehicles from Group ID

The DELETE vehicles by Group ID method provides integration users with the ability to remove vehicles from a specific Group ID. Requests will require the Vehicle Number and the Group ID in the path. Multiple vehicles can be removed to from each Group ID provided as groups can contain multiple vehicles within REVEAL.

The integrated user will be able to remove a vehicle from a specified group. The integration user will need to specify the vehicle by Vehicle Number to be removed from the Group ID provided.

If the Vehicle Number or Group ID are not valid within the account an ERROR will be returned.

Note: if the vehicle is removed from all group associations, it will be placed within the Ungrouped Group within the account. Invoking this method does NOT delete the vehicle record from the REVEAL account.

Operation and Path	DELETE https://fleetmatics.apiportal.akana/cmd/v1/groups/{groupid}/vehicles/ {vehiclenumber}
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

DELETE Vehicles from Group ID Sample Response

DELETE methods will not return an object review. The response will be limited to a set of standard HTTP codes:

· Successfully edited vehicles will return a 200 code

· Unfound Vehicle Numbers, or the unique identifier used for the call, will return a 404 error

· Bad requests, typically due to an error in the call’s content, will return a 400 error

· Invalid tokens or an Authorization problem will return a 401 error

· If the service is unavailable at the time the call was made a 500 error will return

DELETE Geofences from Group ID

The DELETE Geofences by Group ID method provides integration users with the ability to remove geofences from a specific Group ID. Requests will require the Place ID and the Group ID in the path. Multiple geofences can be removed to from each Group ID provided as groups can contain multiple geofences within REVEAL.

The integrated user will be able to remove a Geofence from a specified group. The integration user will need to specify the Geofence by Place ID to be removed from the Group ID provided.

If the Place ID or Group ID are not valid within the account an ERROR will be returned.

Note: if the Geofence is removed from all group associations, it will be placed within 0 Groups. When Groups Selected is 0 the Geofence will be available for review to any users with access to view Geofences within the product. Invoking this method does NOT delete the Geofence record from the REVEAL account.

Operation and Path	DELETE https://fleetmatics.apiportal.akana/cmd/v1/groups/{groupid}/geofences/ {placeid}
HOST	https://fleetmatics.apiportal.akana.com
Accept	application/json
Authorization	Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token> NOTE: the Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

DELETE Geofences from Group ID Sample Response

DELETE methods will not return an object review. The response will be limited to a set of standard HTTP codes:

· Successfully edited vehicles will return a 200 code

· Unfound Vehicle Numbers, or the unique identifier used for the call, will return a 404 error

· Bad requests, typically due to an error in the call’s content, will return a 400 error

· Invalid tokens or an Authorization problem will return a 401 error

· If the service is unavailable at the time the call was made a 500 error will return

Customer Meta Data – Groups API

API Summary Details

GET Group Services

GET All Groups

GET All Groups Request Header

GET All Groups Sample Response

GET All Groups Response Field Breakdown

GET Groups by Group ID

GET Groups by Group ID Request Header

GET Groups by Group ID Sample Response

GET Groups by Group ID Response Field Breakdown

GET Groups by Driver Number

GET Groups by Driver Number Request Header

GET Groups by Driver Number Sample Response

GET Groups by Driver Number Response Field Breakdown

GET Groups by Vehicle Number

GET Groups by Vehicle Number Request Header

GET Groups by Vehicle Number Sample Response

GET Groups by Vehicle Number Response Field Breakdown

GET Groups by Employee ID

GET Groups by Employee ID Request Header

GET Groups by Employee ID Sample Response

GET Groups by Employee ID Response Field Breakdown

GET Drivers by Group ID

GET Drivers by Group ID Request Header

GET Sample Response

GET Drivers by Group ID Response Field Breakdown

GET Users by Group ID

GET Users by Group ID Request Header

GET Users by Group ID Sample Response

GET Users by Group ID Response Field Breakdown

{

"user": {

"FirstName": ""

"LastName": "",

"EmailAddress": "",

"EmployeeId": “”,

"IsAdministrator": “”,

"IsRegionalAdministrator": “”,

"Role": “”,

"IsDriver": “”

},

"_links": null

}

]

GET Vehicles by Group ID

GET Vehicles by Group ID Request Header

GET Vehicles by Group ID Sample Response

GET Vehicles by Group ID Response Field Breakdown

{

"Name": "",

"VehicleNumber": "",

"RegistrationNumber": "",

"VIN": "",

"Make": "",

"Year": "",

"Model": "",

"TankCapacity": "",

"HighwayMPG": "",

"CityMPG": "",

"VehicleSize": "",

"HasNavigationDevice": ""

POST to Group ID

POST Drivers to Group ID

POST Drivers to Group ID Request Body

POST Drivers to Group ID Request Header

POST Drivers to Group ID Response Field Breakdown

POST Drivers to Group ID Sample Response

POST Users to Group ID

POST Users to Group ID Request Body

POST Users to Group ID Request Header

POST Users to Group ID Response Field Breakdown

POST Users to Group ID Sample Response

POST Vehicles to Group ID

POST Vehicles to Group ID Request Body

POST Vehicles to Group ID Request Header

POST Vehicles to Group ID Response Field Breakdown

POST Vehicles to Group ID Sample Request

POST Geofences to Group ID

POST Geofences to Group ID Request Body